ci: Check PR title instead of commits for conventional format #264
Conversation
There was a problem hiding this comment.
I think the action we are currently using has support too for checking only the PR title via:
pull_request:
conventional: true, but I haven't tried it yet (ref. https://commitsar.aevea.ee/configuration/config-file/)
Anyway, I find the action you suggested to be better and it's also more widely adopted, so I think it make sense for us to switch to it 👍
A few nits:
ethan-lowman-dd
dismissed stale reviews from trishankatdatadog and rdimitrov
via
1260893
ethan-lowman-dd
force-pushed
the
ethan.lowman/check-pr-title
branch
from
1a13d0c to
1260893
Compare
By default the token has only read permissions, unless there's a different default setting a the repo or org level. I don't have the permissions to verify this.
In that file, it doesn't look like we're restricting the set of allowed change types, just configuring their order in the changelog. |
There was a problem hiding this comment.
Should we configure the set of allowed change types (here) to be in line with the changelog groups goreleaser builds (here)?
In that file, it doesn't look like we're restricting the set of allowed change types, just configuring their order in the changelog.
The order is set in the goreleaser config file whereas in the first one I think we can specify which types are allowed -
with:
# Configure which types are allowed.
# Default: https://github.com/commitizen/conventional-commit-types
types: |
fix
featCurrently, the changelog will have breaking, fix and feat and everything else will go to others. So my thought was do we want to have separate ones for things like docs, ci, etc and on other side enforce the types we want to allow?
|
@rdimitrov Personally, I think we should leave it flexible, and then if/when well-defined categories emerge, we can formalize it. |
Release Notes: PR titles must now use Conventional Commit format
Types of changes:
Description of the changes being introduced by the pull request:
One of the effects of #234 is that we have to format every commit message using the Conventional Commit format, even though we squash merge PRs, and that commit history is lost. Since the PR title (or in some cases a single commit message) becomes the squashed commit message, that is the place we should check for proper formatting. I swapped in a GitHub action that performs this check.
Please verify and check that the pull request fulfills the following requirements: